Add docs for built-in widgets - #63
Merged
PardhavMaradani merged 3 commits intoAug 12, 2026
Merged
Conversation
Documentation build overview
45 files changed ·
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files
🚀 New features to boost your workflow:
|
PardhavMaradani
marked this pull request as ready for review
August 11, 2026 12:39
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes made in this Pull Request:
PR Checklist
Hi @orbeckst, @jeremyleung521, @amruthesht, @HeydenLabASU,
This PR adds docs for all existing built-in widgets. There is a lot more documentation to add, but this part about built-in widgets is now complete. While adding the docs, I realized that it might help to have a link to the docs directly where users actually use the widget in the dashboard - ie., in the widget details page. I made a note of this and will add this support later.
There is no change to any functionality.
Each widget has basic details and links pointing to MDAnalysis docs about what it does. There is an inputs section that specifies the possible inputs along with their defaults. An output section shows an example plot output. There are notes etc included based on the feedback received during individual widget PRs.
The rtd preview link: https://mdadash--63.org.readthedocs.build/en/63/
Thanks